/**
 * Collaborative Story Development Web Application (CSDApp) 
 * Copyright Anton Strack 2014
 *
 * This file is part of Collaborative Story Development Application (CSDApp).
 *
 * CSDApp is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or any later version.
 *
 * CSDApp is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * CSDApp. If not, see <http://www.gnu.org/licenses/>.
 *
 */
package csdwa;

/**
 * This class represents a state type. The state type is used primarily for
 * tasks and notifications and it represents the current state of a resource.
 *
 * @author Anton Strack
 */
public class State {

    /**
     * Id of the resource type
     */
    private int id;
    /**
     * The resource type id specifies the type of state this state is.
     */
    private int resourceTypeId;
    /**
     * Name of the resource type as it appears to the end user.
     */
    private String name;
    /**
     * Description of the resource type as it appears to the end user.
     */
    private String description;

    /**
     * Default no argument constructor
     */
    public State() {
    }

    /**
     * Default constructor with the ability to set the resourceTypeId
     *
     * @param resourceTypeId the type of state this object is.
     */
    public State(int resourceTypeId) {
        this.resourceTypeId = resourceTypeId;
    }

    /**
     * Construct the resource type with all of it's state variables.
     *
     * @param id the id of the resource type.
     * @param resourceTypeId the id of the parent id type if one exists. Zero if
     * there are no parent types.
     * @param name the name of the resource type.
     * @param desc the description of the resource type.
     */
    public State(int id, int resourceTypeId, String name, String desc) {
        this.id = id;
        this.resourceTypeId = resourceTypeId;
        this.name = name;
        this.description = desc;
    }

    /**
     * @return the id
     */
    public int getId() {
        return id;
    }

    /**
     * @param id the id to set
     */
    public void setId(int id) {
        this.id = id;
    }

    /**
     * @return the resourceTypeId
     */
    public int getResourceTypeId() {
        return resourceTypeId;
    }

    /**
     * @param resourceTypeId the resourceTypeId to set
     */
    public void setResourceTypeId(int resourceTypeId) {
        this.resourceTypeId = resourceTypeId;
    }

    /**
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * @param name the name to set
     */
    public void setName(String name) {
        this.name = name;
    }

    /**
     * @return the description
     */
    public String getDescription() {
        return description;
    }

    /**
     * @param description the description to set
     */
    public void setDescription(String description) {
        this.description = description;
    }
}
